home *** CD-ROM | disk | FTP | other *** search
/ PC World 2007 September / PCWorld_2007-09_cd.bin / v cisle / wireshark / wireshark-setup-0.99.6a.exe / snmp / mibs / DISMAN-NSLOOKUP-MIB.txt < prev    next >
Text File  |  2006-07-05  |  19KB  |  510 lines
  1. DISMAN-NSLOOKUP-MIB DEFINITIONS ::= BEGIN
  2.  
  3. IMPORTS
  4.     MODULE-IDENTITY, OBJECT-TYPE,
  5.     Unsigned32, mib-2, Integer32
  6.         FROM SNMPv2-SMI                  -- RFC2578
  7.     RowStatus
  8.         FROM SNMPv2-TC                   -- RFC2579
  9.     MODULE-COMPLIANCE, OBJECT-GROUP
  10.         FROM SNMPv2-CONF                 -- RFC2580
  11.     SnmpAdminString
  12.         FROM SNMP-FRAMEWORK-MIB          -- RFC3411
  13.     InetAddressType, InetAddress
  14.         FROM INET-ADDRESS-MIB;           -- RFC4001
  15.  
  16.  lookupMIB MODULE-IDENTITY
  17.     LAST-UPDATED "200606130000Z"         -- 13 June 2006
  18.     ORGANIZATION "IETF Distributed Management Working Group"
  19.     CONTACT-INFO
  20.         "Juergen Quittek
  21.  
  22.         NEC Europe Ltd.
  23.         Network Laboratories
  24.         Kurfuersten-Anlage 36
  25.         69115 Heidelberg
  26.         Germany
  27.  
  28.         Phone: +49 6221 4342-115
  29.         Email: quittek@netlab.nec.de"
  30.     DESCRIPTION
  31.         "The Lookup MIB (DISMAN-NSLOOKUP-MIB) enables determination
  32.         of either the name(s) corresponding to a host address or of
  33.         the address(es) associated with a host name at a remote
  34.         host.
  35.  
  36.         Copyright (C) The Internet Society (2006).  This version of
  37.         this MIB module is part of RFC 4560; see the RFC itself for
  38.         full legal notices."
  39.  
  40.      --  Revision history
  41.  
  42.      REVISION     "200606130000Z"         -- 13 June 2006
  43.      DESCRIPTION
  44.          "Updated version, published as RFC 4560.
  45.              - Replaced references to RFC 2575 by RFC 3415
  46.              - Replaced references to RFC 2571 by RFC 3411
  47.              - Replaced references to RFC 2851 by RFC 4001
  48.              - Added value enabled(1) to SYNTAX clause of
  49.                lookupCtlOperStatus
  50.              - Added lookupMinimumCompliance
  51.              - Defined semantics of value 0 for object
  52.                lookupPurgeTime
  53.              - Added DEFVAL { unknown } to object
  54.                lookupCtlTargetAddressType OBJECT-TYPE"
  55.  
  56.      REVISION     "200009210000Z"         -- 21 September 2000
  57.      DESCRIPTION
  58.          "Initial version, published as RFC 2925."
  59.     ::= { mib-2 82 }
  60.  
  61.  -- Top level structure of the MIB
  62.  
  63.  lookupObjects        OBJECT IDENTIFIER ::= { lookupMIB 1 }
  64.  lookupConformance    OBJECT IDENTIFIER ::= { lookupMIB 2 }
  65.  
  66.  -- Simple Object Definitions
  67.  
  68.  lookupMaxConcurrentRequests OBJECT-TYPE
  69.     SYNTAX      Unsigned32
  70.     UNITS       "requests"
  71.     MAX-ACCESS  read-write
  72.     STATUS      current
  73.     DESCRIPTION
  74.        "The maximum number of concurrent active lookup requests
  75.        that are allowed within an agent implementation.  A value
  76.        of 0 for this object implies that there is no limit for
  77.        the number of concurrent active requests in effect.
  78.  
  79.        The limit applies only to new requests being activated.
  80.        When a new value is set, the agent will continue processing
  81.        all the requests already active, even if their number
  82.        exceed the limit just imposed."
  83.     DEFVAL { 10 }
  84.     ::= { lookupObjects 1 }
  85.  
  86.  lookupPurgeTime OBJECT-TYPE
  87.     SYNTAX      Unsigned32 (0..86400)
  88.     UNITS       "seconds"
  89.     MAX-ACCESS  read-write
  90.     STATUS      current
  91.     DESCRIPTION
  92.        "The amount of time to wait before automatically
  93.        deleting an entry in the lookupCtlTable and any
  94.        dependent lookupResultsTable entries
  95.        after the lookup operation represented by a
  96.        lookupCtlEntry has been completed.
  97.        A lookupCtEntry is considered complete
  98.        when its lookupCtlOperStatus object has a
  99.        value of completed(3).
  100.  
  101.        A value of 0 indicates that automatic deletion
  102.        of entries is disabled."
  103.     DEFVAL { 900 }  -- 15 minutes as default
  104.     ::= { lookupObjects 2 }
  105.  
  106.  -- Lookup Control Table
  107.  
  108.  lookupCtlTable OBJECT-TYPE
  109.     SYNTAX      SEQUENCE OF LookupCtlEntry
  110.     MAX-ACCESS  not-accessible
  111.     STATUS      current
  112.     DESCRIPTION
  113.         "Defines the Lookup Control Table for providing
  114.         the capability of performing a lookup operation
  115.         for a symbolic host name or for a host address
  116.         from a remote host."
  117.    ::= { lookupObjects 3 }
  118.  
  119.  lookupCtlEntry OBJECT-TYPE
  120.     SYNTAX      LookupCtlEntry
  121.     MAX-ACCESS  not-accessible
  122.     STATUS      current
  123.     DESCRIPTION
  124.         "Defines an entry in the lookupCtlTable.  A
  125.         lookupCtlEntry is initially indexed by
  126.         lookupCtlOwnerIndex, which is a type of SnmpAdminString,
  127.         a textual convention that allows for the use of the SNMPv3
  128.         View-Based Access Control Model (RFC 3415, VACM)
  129.         and that also allows a management application to identify
  130.         its entries.  The second index element,
  131.         lookupCtlOperationName, enables the same
  132.         lookupCtlOwnerIndex entity to have multiple outstanding
  133.         requests.  The value of lookupCtlTargetAddressType
  134.         determines which lookup function to perform."
  135.     INDEX {
  136.              lookupCtlOwnerIndex,
  137.              lookupCtlOperationName
  138.           }
  139.     ::= { lookupCtlTable 1 }
  140.  
  141.  LookupCtlEntry ::=
  142.     SEQUENCE {
  143.         lookupCtlOwnerIndex         SnmpAdminString,
  144.         lookupCtlOperationName      SnmpAdminString,
  145.         lookupCtlTargetAddressType  InetAddressType,
  146.         lookupCtlTargetAddress      InetAddress,
  147.         lookupCtlOperStatus         INTEGER,
  148.         lookupCtlTime               Unsigned32,
  149.         lookupCtlRc                 Integer32,
  150.         lookupCtlRowStatus          RowStatus
  151.     }
  152.  
  153.  lookupCtlOwnerIndex OBJECT-TYPE
  154.     SYNTAX      SnmpAdminString (SIZE(0..32))
  155.     MAX-ACCESS  not-accessible
  156.     STATUS      current
  157.     DESCRIPTION
  158.        "To facilitate the provisioning of access control by a
  159.        security administrator using the View-Based Access
  160.        Control Model (RFC 2575, VACM) for tables in which
  161.        multiple users may need to create or
  162.        modify entries independently, the initial index is used as
  163.        an 'owner index'.  Such an initial index has a syntax of
  164.        SnmpAdminString and can thus be trivially mapped to a
  165.  
  166.        securityName or groupName defined in VACM, in
  167.        accordance with a security policy.
  168.  
  169.        When used in conjunction with such a security policy all
  170.        entries in the table belonging to a particular user (or
  171.        group) will have the same value for this initial index.
  172.        For a given user's entries in a particular table, the
  173.        object identifiers for the information in these entries
  174.        will have the same subidentifiers (except for the
  175.        'column' subidentifier) up to the end of the encoded
  176.        owner index.  To configure VACM to permit access to this
  177.        portion of the table, one would create
  178.        vacmViewTreeFamilyTable entries with the value of
  179.        vacmViewTreeFamilySubtree including the owner index
  180.        portion, and vacmViewTreeFamilyMask 'wildcarding' the
  181.        column subidentifier.  More elaborate configurations
  182.        are possible."
  183.     ::= { lookupCtlEntry 1 }
  184.  
  185.  lookupCtlOperationName OBJECT-TYPE
  186.     SYNTAX      SnmpAdminString (SIZE(0..32))
  187.     MAX-ACCESS  not-accessible
  188.     STATUS      current
  189.     DESCRIPTION
  190.         "The name of a lookup operation.  This is locally unique,
  191.         within the scope of an lookupCtlOwnerIndex."
  192.     ::= { lookupCtlEntry 2 }
  193.  
  194.  lookupCtlTargetAddressType OBJECT-TYPE
  195.     SYNTAX      InetAddressType
  196.     MAX-ACCESS  read-create
  197.     STATUS      current
  198.     DESCRIPTION
  199.         "Specifies the type of address for performing a
  200.         lookup operation for a symbolic host name or for a host
  201.         address from a remote host.
  202.  
  203.         Specification of dns(16) as the value for this object
  204.         means that a function such as, for example, getaddrinfo()
  205.         or gethostbyname() should be performed to return one or
  206.         more numeric addresses.  Use of a value of either ipv4(1)
  207.         or ipv6(2) means that a functions such as, for example,
  208.         getnameinfo() or gethostbyaddr() should be used to return
  209.         the symbolic names associated with a host."
  210.     DEFVAL { unknown }
  211.     ::= { lookupCtlEntry 3 }
  212.  
  213.  lookupCtlTargetAddress OBJECT-TYPE
  214.     SYNTAX      InetAddress
  215.     MAX-ACCESS  read-create
  216.     STATUS      current
  217.     DESCRIPTION
  218.         "Specifies the address used for a resolver lookup at a
  219.         remote host.  The corresponding lookupCtlTargetAddressType
  220.         objects determines its type, as well as the function
  221.         that can be requested.
  222.  
  223.         A value for this object MUST be set prior to
  224.         transitioning its corresponding lookupCtlEntry to
  225.         active(1) via lookupCtlRowStatus."
  226.     ::= { lookupCtlEntry 4 }
  227.  
  228.  lookupCtlOperStatus OBJECT-TYPE
  229.     SYNTAX      INTEGER {
  230.                    enabled(1),    -- operation is active
  231.                    notStarted(2), -- operation has not started
  232.                    completed(3)   -- operation is done
  233.                 }
  234.     MAX-ACCESS  read-only
  235.     STATUS      current
  236.     DESCRIPTION
  237.         "Reflects the operational state of an lookupCtlEntry:
  238.  
  239.            enabled(1)    - Operation is active.
  240.            notStarted(2) - Operation has not been enabled.
  241.            completed(3)  - Operation has been completed.
  242.  
  243.          An operation is automatically enabled(1) when its
  244.          lookupCtlRowStatus object is transitioned to active(1)
  245.          status.  Until this occurs, lookupCtlOperStatus MUST
  246.          report a value of notStarted(2).  After the lookup
  247.          operation is completed (success or failure), the value
  248.          for lookupCtlOperStatus MUST be transitioned to
  249.          completed(3)."
  250.     ::= { lookupCtlEntry 5 }
  251.  
  252.  lookupCtlTime OBJECT-TYPE
  253.     SYNTAX      Unsigned32
  254.     UNITS       "milliseconds"
  255.     MAX-ACCESS  read-only
  256.     STATUS      current
  257.     DESCRIPTION
  258.         "Reports the number of milliseconds that a lookup
  259.         operation required to be completed at a remote host.
  260.         Completed means operation failure as well as
  261.  
  262.         success."
  263.     ::= { lookupCtlEntry 6 }
  264.  
  265.  lookupCtlRc OBJECT-TYPE
  266.     SYNTAX      Integer32
  267.     MAX-ACCESS  read-only
  268.     STATUS      current
  269.     DESCRIPTION
  270.         "The system-specific return code from a lookup
  271.         operation.  All implementations MUST return a value
  272.         of 0 for this object when the remote lookup
  273.         operation succeeds.  A non-zero value for this
  274.         objects indicates failure.  It is recommended that
  275.         implementations return the error codes that are
  276.         generated by the lookup function used."
  277.     ::= { lookupCtlEntry 7 }
  278.  
  279.  lookupCtlRowStatus OBJECT-TYPE
  280.     SYNTAX      RowStatus
  281.     MAX-ACCESS  read-create
  282.     STATUS      current
  283.     DESCRIPTION
  284.         "This object allows entries to be created and deleted
  285.         in the lookupCtlTable.
  286.  
  287.         A remote lookup operation is started when an
  288.         entry in this table is created via an SNMP set
  289.         request and the entry is activated.  This
  290.         occurs by setting the value of this object
  291.         to CreateAndGo(4) during row creation or
  292.         by setting this object to active(1) after
  293.         the row is created.
  294.  
  295.         A value MUST be specified for lookupCtlTargetAddress
  296.         prior to the acceptance of a transition to active(1) state.
  297.         A remote lookup operation starts when its entry
  298.         first becomes active(1).  Transitions in and
  299.         out of active(1) state have no effect on the
  300.         operational behavior of a remote lookup
  301.         operation, with the exception that deletion of
  302.         an entry in this table by setting its RowStatus
  303.         object to destroy(6) will stop an active
  304.         remote lookup operation.
  305.  
  306.         The operational state of a remote lookup operation
  307.         can be determined by examination of its
  308.         lookupCtlOperStatus object."
  309.     REFERENCE
  310.         "See definition of RowStatus in RFC 2579,
  311.         'Textual Conventions for SMIv2.'"
  312.     ::= { lookupCtlEntry 8 }
  313.  
  314. -- Lookup Results Table
  315.  
  316.  lookupResultsTable OBJECT-TYPE
  317.     SYNTAX      SEQUENCE OF LookupResultsEntry
  318.     MAX-ACCESS  not-accessible
  319.     STATUS      current
  320.     DESCRIPTION
  321.         "Defines the Lookup Results Table for providing
  322.         the capability of determining the results of a
  323.         operation at a remote host.
  324.  
  325.         One or more entries are added to the
  326.         lookupResultsTable when a lookup operation,
  327.         as reflected by an lookupCtlEntry, is completed
  328.         successfully.  All entries related to a
  329.         successful lookup operation MUST be added
  330.         to the lookupResultsTable at the same time
  331.         that the associating lookupCtlOperStatus
  332.         object is transitioned to completed(2).
  333.  
  334.         The number of entries added depends on the
  335.         results determined for a particular lookup
  336.         operation.  All entries associated with an
  337.         lookupCtlEntry are removed when the
  338.         lookupCtlEntry is deleted.
  339.  
  340.         A remote host can be multi-homed and have more than one IP
  341.         address associated with it (returned by lookup function),
  342.         or it can have more than one symbolic name (returned
  343.         by lookup function).
  344.  
  345.         A function such as, for example, getnameinfo() or
  346.         gethostbyaddr() is called with a host address as its
  347.         parameter and is used primarily to determine a symbolic
  348.         name to associate with the host address.  Entries in the
  349.         lookupResultsTable MUST be made for each host name
  350.         returned.  If the function identifies an 'official host
  351.         name,' then this symbolic name MUST be assigned a
  352.         lookupResultsIndex of 1.
  353.  
  354.         A function such as, for example, getaddrinfo() or
  355.         gethostbyname() is called with a symbolic host name and is
  356.         used primarily to retrieve a host address.  The entries
  357.  
  358.         MUST be stored in the order that they are retrieved from
  359.         the lookup function.  lookupResultsIndex 1 MUST be
  360.         assigned to the first entry."
  361.    ::= { lookupObjects 4 }
  362.  
  363.  lookupResultsEntry OBJECT-TYPE
  364.     SYNTAX      LookupResultsEntry
  365.     MAX-ACCESS  not-accessible
  366.     STATUS      current
  367.     DESCRIPTION
  368.         "Defines an entry in the lookupResultsTable.  The
  369.         first two index elements identify the
  370.         lookupCtlEntry that a lookupResultsEntry belongs
  371.         to.  The third index element selects a single
  372.         lookup operation result."
  373.     INDEX {
  374.              lookupCtlOwnerIndex,
  375.              lookupCtlOperationName,
  376.              lookupResultsIndex
  377.           }
  378.     ::= { lookupResultsTable 1 }
  379.  
  380.  LookupResultsEntry ::=
  381.     SEQUENCE {
  382.         lookupResultsIndex        Unsigned32,
  383.         lookupResultsAddressType  InetAddressType,
  384.         lookupResultsAddress      InetAddress
  385.      }
  386.  
  387.  lookupResultsIndex OBJECT-TYPE
  388.     SYNTAX      Unsigned32 (1..'ffffffff'h)
  389.     MAX-ACCESS  not-accessible
  390.     STATUS      current
  391.     DESCRIPTION
  392.         "Entries in the lookupResultsTable are created when
  393.         the result of a lookup operation is determined.
  394.  
  395.         Entries MUST be stored in the lookupResultsTable in
  396.         the order that they are retrieved.  Values assigned
  397.         to lookupResultsIndex MUST start at 1 and increase
  398.         consecutively."
  399.     ::= { lookupResultsEntry 1 }
  400.  
  401.  lookupResultsAddressType OBJECT-TYPE
  402.     SYNTAX      InetAddressType
  403.     MAX-ACCESS  read-only
  404.     STATUS      current
  405.     DESCRIPTION
  406.         "Indicates the type of result of a remote lookup
  407.         operation.  A value of unknown(0) implies either that
  408.         the operation hasn't been started or that
  409.         it has failed."
  410.     ::= { lookupResultsEntry 2 }
  411.  
  412.  lookupResultsAddress OBJECT-TYPE
  413.     SYNTAX      InetAddress
  414.     MAX-ACCESS  read-only
  415.     STATUS      current
  416.     DESCRIPTION
  417.         "Reflects a result for a remote lookup operation
  418.         as per the value of lookupResultsAddressType.
  419.  
  420.         The address type (InetAddressType) that relates to
  421.         this object is specified by the corresponding value
  422.         of lookupResultsAddress."
  423.     ::= { lookupResultsEntry 3 }
  424.  
  425.  -- Conformance information
  426.  -- Compliance statements
  427.  
  428.  lookupCompliances OBJECT IDENTIFIER ::= { lookupConformance 1 }
  429.  lookupGroups      OBJECT IDENTIFIER ::= { lookupConformance 2 }
  430.  
  431.  -- Compliance statements
  432.  
  433.  lookupCompliance MODULE-COMPLIANCE
  434.     STATUS  current
  435.     DESCRIPTION
  436.             "The compliance statement for SNMP entities that
  437.             fully implement the DISMAN-NSLOOKUP-MIB."
  438.     MODULE  -- this module
  439.         MANDATORY-GROUPS { lookupGroup }
  440.  
  441.         OBJECT lookupMaxConcurrentRequests
  442.         MIN-ACCESS  read-only
  443.         DESCRIPTION
  444.             "The agent is not required to support set
  445.             operations to this object."
  446.  
  447.         OBJECT lookupPurgeTime
  448.         MIN-ACCESS  read-only
  449.         DESCRIPTION
  450.             "The agent is not required to support a set
  451.             operation to this object."
  452.     ::= { lookupCompliances 1 }
  453.  
  454.  lookupMinimumCompliance MODULE-COMPLIANCE
  455.     STATUS  current
  456.     DESCRIPTION
  457.             "The minimum compliance statement for SNMP entities
  458.             that implement the minimal subset of the
  459.             DISMAN-NSLOOKUP-MIB.  Implementors might choose this
  460.             subset for small devices with limited resources."
  461.     MODULE  -- this module
  462.         MANDATORY-GROUPS { lookupGroup }
  463.  
  464.         OBJECT lookupMaxConcurrentRequests
  465.         MIN-ACCESS  read-only
  466.         DESCRIPTION
  467.             "The agent is not required to support set
  468.             operations to this object."
  469.  
  470.         OBJECT lookupPurgeTime
  471.         MIN-ACCESS  read-only
  472.         DESCRIPTION
  473.             "The agent is not required to support a set
  474.             operation to this object."
  475.  
  476.         OBJECT lookupCtlRowStatus
  477.         MIN-ACCESS  read-only
  478.         DESCRIPTION
  479.             "Write access is not required.  If write access is
  480.             not supported, then at least one entry in the
  481.             lookupCtlTable MUST be established already when the SNMP
  482.             agent starts offering access to the NSLOOKUP-MIB module.
  483.             If, in such a case, only a single entry is offered, then
  484.             it is RECOMMENDED that this entry use strings with a
  485.             length of 0 for both of its two index objects."
  486.     ::= { lookupCompliances 2 }
  487.  
  488.  -- MIB groupings
  489.  
  490.  lookupGroup OBJECT-GROUP
  491.    OBJECTS {
  492.              lookupMaxConcurrentRequests,
  493.              lookupPurgeTime,
  494.              lookupCtlOperStatus,
  495.              lookupCtlTargetAddressType,
  496.              lookupCtlTargetAddress,
  497.              lookupCtlTime,
  498.              lookupCtlRc,
  499.              lookupCtlRowStatus,
  500.              lookupResultsAddressType,
  501.              lookupResultsAddress
  502.            }
  503.    STATUS  current
  504.    DESCRIPTION
  505.        "The group of objects that constitute the remote
  506.        Lookup operation."
  507.     ::= { lookupGroups 1 }
  508.  
  509. END
  510.